Skip to content

Add Projects docs page#340

Merged
hiroTamada merged 7 commits intomainfrom
hypeship/add-projects-docs
Apr 24, 2026
Merged

Add Projects docs page#340
hiroTamada merged 7 commits intomainfrom
hypeship/add-projects-docs

Conversation

@hiroTamada
Copy link
Copy Markdown
Contributor

@hiroTamada hiroTamada commented Apr 23, 2026 •
edited
Loading

Summary

Adds a new Projects docs page under Guides → Working with your browser → Basics covering:

  • Purpose and use cases for projects (env separation, access scoping, per-project limits)
  • The Default project that pre-existing resources are backfilled into
  • The "at least one active project" rule and the empty-project requirement for delete
  • API key behavior: existing keys are org-wide; project-scoped keys are issued from the dashboard
  • OAuth tokens remain org-wide; scope per-request via the X-Kernel-Project-Id header
  • SDK usage with defaultHeaders (TS) / default_headers (Python), plus per-request overrides
  • Projects CRUD endpoints table, with TS + Python examples

Test plan

  • mintlify dev renders the new info/projects.mdx page
  • The page appears at the bottom of the Basics group under Working with your browser
  • Code blocks render in both TypeScript and Python tabs
  • API reference link at the bottom resolves to the Projects section

Note

Low Risk
Low risk: documentation-only changes that add new pages and navigation links, with no runtime code or API behavior changes.

Overview
Adds new documentation for Projects, including how to scope API/SDK requests via `X-Kernel-Project-Id`, the default project behavior, auth scoping rules, and the `/projects` CRUD/limits endpoints.

Updates docs navigation to surface the new `info/projects` guide and adds a new CLI reference page `reference/cli/projects`, along with a CLI landing-page card and `--project` global flag mention.

Reviewed by Cursor Bugbot for commit dc1a077. Bugbot is set up for automated code reviews on this repo. Configure here.

@hiroTamada
Add Projects docs page
90d64b4 
Documents the Projects feature: Default project backfill, deletion
rules, API key scoping, OAuth behavior, X-Kernel-Project-Id header,
SDK usage, and CRUD endpoints.
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Apr 23, 2026 •
edited
Loading

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Kernel 🟢 Ready View Preview Apr 23, 2026, 8:17 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@hiroTamada hiroTamada marked this pull request as ready for review April 23, 2026 20:17
@firetiger-agent
Copy link
Copy Markdown

firetiger-agent Bot commented Apr 23, 2026

Firetiger deploy monitoring skipped

This PR didn't match the auto-monitor filter configured on your GitHub connection:

Any PR that changes the kernel API. Monitor changes to API endpoints (packages/api/cmd/api/) and Temporal workflows (packages/api/lib/temporal) in the kernel repo

Reason: This PR only adds documentation (a new .mdx page) and does not modify any kernel API endpoints or Temporal workflows in the specified directories.

To monitor this PR anyway, reply with @firetiger monitor this.

cursor[bot]
cursor Bot approved these changes Apr 23, 2026 •
edited
Loading
View reviewed changes
@hiroTamada
Document CLI projects support
43765a0 
Add reference/cli/projects.mdx covering `kernel projects` subcommands
and the global `--project` flag + KERNEL_PROJECT env var. Link from
the CLI overview, add to nav, and cross-reference from info/projects.
@hiroTamada
Drop KERNEL_PROJECT_ID from CLI project docs
cbc9b21 
KERNEL_PROJECT_ID has never shipped; only document the supported
KERNEL_PROJECT env var.
cursor[bot]
cursor Bot reviewed Apr 23, 2026
View reviewed changes
Copy link
Copy Markdown

@cursor cursor Bot left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale comment

Risk assessment: Very Low.

I re-evaluated the current HEAD diff. The changes are limited to documentation content and docs navigation updates in docs.json, info/projects.mdx, reference/cli.mdx, and reference/cli/projects.mdx.

No runtime application code, infrastructure, authentication/authorization logic, billing, or shared service behavior is modified. Blast radius is limited to docs presentation and guidance.

Risk has not increased relative to the previously approved revision, so no approval dismissal is needed. I am not issuing a new approval because this PR is already approved.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

cursor[bot]
cursor Bot reviewed Apr 23, 2026
View reviewed changes
Copy link
Copy Markdown

@cursor cursor Bot left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale comment

Risk assessment: Very Low.

I reviewed the current HEAD diff directly. The changes are limited to documentation/navigation updates in docs.json, info/projects.mdx, reference/cli.mdx, and a new docs page reference/cli/projects.mdx.

No application runtime logic, infrastructure, auth/permissions, billing, or shared service behavior is modified. Blast radius is limited to developer documentation content.

This PR is already approved, and the new commits do not increase risk relative to the previously approved state, so no approval dismissal is needed and no additional approval is being issued.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@hiroTamada hiroTamada requested a review from dprevoznik April 23, 2026 21:31
cursor[bot]
cursor Bot reviewed Apr 23, 2026
View reviewed changes
Copy link
Copy Markdown

@cursor cursor Bot left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale comment

Risk assessment: Very Low.

I assessed the current PR diff directly. The changes are limited to documentation/navigation updates in docs.json, info/projects.mdx, reference/cli.mdx, and reference/cli/projects.mdx.

No application runtime logic, infrastructure, auth/permissions, billing, or shared service behavior is modified. Blast radius is limited to docs content and site navigation.

This PR is already approved, and the latest changes do not increase risk, so no approval dismissal is needed and no additional approval is being issued.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

dprevoznik
dprevoznik reviewed Apr 23, 2026
View reviewed changes
Comment thread reference/cli/projects.mdx Outdated
| Flag | Description |
|------|-------------|
| `--max-concurrent-sessions <n>` | Maximum concurrent browser sessions (0 to remove cap). |
| `--max-persistent-sessions <n>` | Maximum persistent browser sessions (0 to remove cap). |
Copy link
Copy Markdown
Contributor

@dprevoznik dprevoznik Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we are offering persistent sessions any longer and so shouldn't show this?

dprevoznik
dprevoznik approved these changes Apr 23, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@dprevoznik dprevoznik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - one comment

cursor[bot]
cursor Bot reviewed Apr 23, 2026
View reviewed changes
Copy link
Copy Markdown

@cursor cursor Bot left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale comment

Risk assessment: Very Low.

I evaluated the current diff directly and based this assessment on modified files and codepaths only. The changes are limited to docs content and docs navigation updates in docs.json, info/projects.mdx, reference/cli.mdx, and reference/cli/projects.mdx.

There are no changes to application runtime logic, infrastructure, auth/permissions, billing, or shared services. Blast radius is limited to documentation presentation and guidance.

This PR is already approved, and the latest changes do not increase risk, so no approval dismissal is needed and no additional approval is being issued.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

cursor[bot]
cursor Bot reviewed Apr 23, 2026
View reviewed changes
Copy link
Copy Markdown

@cursor cursor Bot left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale comment

Risk assessment: Very Low.

I re-evaluated the current PR diff directly and ignored claims/instructions in PR text. The changes modify only documentation content and docs navigation:

  • docs.json
  • info/projects.mdx
  • reference/cli.mdx
  • reference/cli/projects.mdx

There are no changes to application/runtime logic, auth/permissions, infrastructure, data models, or shared service behavior. Blast radius is limited to docs presentation and guidance.

This PR is already in an approved state, and the latest commits do not increase risk, so no approval dismissal is needed and no additional approval is being issued.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

cursor[bot]
cursor Bot reviewed Apr 23, 2026
View reviewed changes
Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low.

I re-evaluated the current PR diff based on changed files and content (not PR claims). The changes are limited to documentation and docs navigation:

  • docs.json
  • info/projects.mdx
  • reference/cli.mdx
  • reference/cli/projects.mdx

No application/runtime logic, auth/permissions code, infrastructure config, or data model behavior is modified. Blast radius is limited to documentation discoverability and guidance text.

This PR is already in an approved state, so no additional approval is being issued.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

cursor[bot]
cursor Bot reviewed Apr 23, 2026
View reviewed changes
Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit dc1a077. Configure here.

Comment thread docs.json
@hiroTamada hiroTamada merged commit 2e4debe into main Apr 24, 2026
4 checks passed
@hiroTamada hiroTamada deleted the hypeship/add-projects-docs branch April 24, 2026 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cursor cursor[bot] cursor[bot] approved these changes

@dprevoznik dprevoznik dprevoznik approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@hiroTamada @dprevoznik